/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies, 
 * either expressed or implied, of the CometMI Project.
 */
package org.cometmi.gwt.shared.util;

import org.cometmi.gwt.shared.MiObject;

public interface WrapperFactory
{
	/**
	 * Returns an empty wrapper (with no defined instance).
	 * 
	 * @param objectClass The class of the object to be wrapped.
	 * @return The requested wrapper.
	 */
	ObjectWrapper createWrapper(Class<? extends MiObject> objectClass);

	/**
	 * Returns a wrapper whose instance is created providing to constructor
	 * given arguments.
	 * 
	 * @param objectClass The class of the object to be wrapped.
	 * @param signature The constructor signature (it can be optional depending
	 *        on the implementation).
	 * @param args Inner instance constructor arguments.
	 * @return The requested wrapper
	 * @throws Exception
	 */
	ObjectWrapper createWrapper(Class<? extends MiObject> objectClass, String signature, Object[] args)
			throws Exception;

	/**
	 * Returns a wrapper whose instance is created providing to constructor
	 * given arguments. Instead of the class in this method is provided the name
	 * of the class. Note that the name of the class should be obtained by a
	 * class object by the {@link Class#getName()} method.
	 * 
	 * @param targetClassName The string representation of a class.
	 * @param argsSignature The target object constructor signature.
	 * @param constructorArgs Inner instance constructor arguments.
	 * @return The requested wrapper.
	 * @throws Exception
	 */
	ObjectWrapper createWrapper(String targetClassName, String argsSignature, Object[] constructorArgs)
			throws Exception;
}
